﻿//-----------------------------------------------------------------------
// <copyright file="IFuture.cs" company="Nathan Miller">
// Copyright (c) Nathan Miller.
//
// Permission is hereby granted, free of charge, to any person obtaining
// a copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to
// permit persons to whom the Software is furnished to do so, subject to
// the following conditions:
// 
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
// </copyright>
//-----------------------------------------------------------------------
namespace TileTool.Threading.Future.Generic
{
    using System;

    /// <summary>
    /// A future object which has a result associated with it.
    /// </summary>
    /// <typeparam name="ResultType">Type of result that is being computed.</typeparam>
    public interface IFuture<ResultType> : IFuture
    {
        #region Properties

        /// <summary>
        /// Gets the result that was computed. The value is only valid if
        /// State is equal to FutureState.Complete.
        /// </summary>
        ResultType Result
        {
            get;
        }

        #endregion

        #region Methods

        /// <summary>
        /// Method to call when the future is complete either via success
        /// or failure.
        /// 
        /// If a user of the future object calls this method after the
        /// state has been set to completed, error or canceled, the provided
        /// method should be called immediately.
        /// 
        /// The method will be called on the same thread that the IFuture object
        /// was created on.
        /// </summary>
        /// <param name="func">Method to call.</param>
        void OnComplete(Action<IFuture<ResultType>> func);

        #endregion
    }
}
